Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use include-tagged macro for high level client docs #23438

Merged
merged 1 commit into from
Mar 20, 2017

Conversation

nik9000
Copy link
Member

@nik9000 nik9000 commented Mar 1, 2017

This should make it simpler to include example snippets from
tests.

Relates to #23351

This should make it simpler to include example snippets from
tests.
@nik9000 nik9000 added the >docs General docs changes label Mar 1, 2017
@nik9000
Copy link
Member Author

nik9000 commented Mar 1, 2017

Needs elastic/docs#151

Copy link
Member

@dadoonet dadoonet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks very nice. Thanks for doing that!

include::delete.asciidoc[]

:doc-tests!:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious about what is the effect of this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clears the variable so it isn't visible outside of this section.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know. Thanks!

@nik9000 nik9000 merged commit 23b8b97 into elastic:master Mar 20, 2017
@nik9000
Copy link
Member Author

nik9000 commented Mar 20, 2017

Thanks for reviewing @dadoonet! I've just merged the required change to the docs repository so I've merged this too.

@dadoonet
Copy link
Member

❤️ ! awesome !

@nik9000
Copy link
Member Author

nik9000 commented Mar 20, 2017

❤️ ! awesome !

Enjoy!

jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Mar 22, 2017
* master:
  Fix typo in allocation explain API docs
  Add unit tests for ReverseNestedAggregator (elastic#23651)
  Revert "Revert "Build: Upgrade min gradle to 3.3 (elastic#23544)""
  Revert "Build: Upgrade min gradle to 3.3 (elastic#23544)"
  Build: Upgrade min gradle to 3.3 (elastic#23544)
  Fix took assertion in response filter test
  Search took time should use a relative clock
  Adds toString() to snapshot operations in progress
  Docs: fix a typo in transport client's put-mapping.asciidoc (elastic#23607)
  Use include-tagged macro for high level client docs (elastic#23438)
  Update fill-column in .dir-locals.el to 100 characters
  Setup keystore during integration tests (elastic#22966)
  Fix typo 'Elastisearch' -> 'Elasticsearch' (elastic#23633)
  Comment and blank line cleanups (elastic#23647)
  docs: guidelines for students and teachers (elastic#23648)
  Fix MapperService StackOverflowError (elastic#23605)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes v6.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants